RunCompare - Installation guide
===============================

RunCompare shows the history of your backtest runs inside StrategyQuant, so you
can see exactly how each change to your strategy affects the results.

Installing takes about a minute. There is NOTHING to configure.


What you need
-------------
- StrategyQuant X installed on Windows
- The RunCompare zip you just downloaded


Step 1 - Unzip
--------------
Right-click the downloaded zip -> "Extract All".
Inside you will find:
   - a folder called   RunCompare
   - a file called      start-sq.bat
   - this guide


Step 2 - Copy the "RunCompare" folder into StrategyQuant
--------------------------------------------------------
Copy the whole "RunCompare" folder into your StrategyQuant install, here:

   C:\StrategyQuantX###\user\extend\ResultsPlugins\

(### = your version number, e.g. StrategyQuantX144. If the folder
"extend\ResultsPlugins" doesn't exist yet, just create it.)


Step 3 - Copy "start-sq.bat" into the "user" folder
---------------------------------------------------
Copy "start-sq.bat" here:

   C:\StrategyQuantX###\user\


Step 4 - Start StrategyQuant with start-sq.bat
----------------------------------------------
From now on, start StrategyQuant by double-clicking start-sq.bat (you can pin it
to the taskbar or make a desktop shortcut). It's the only file you ever click -
it starts RunCompare in the background and then opens StrategyQuant.

That's it. Open a strategy, run a backtest, and RunCompare starts recording.


Using it (30-second version)
----------------------------
1. Save your strategy and give it a name - ideally a UNIQUE one. RunCompare
   files your run history under that name.
2. Run a backtest. A new row appears in RunCompare with all the key metrics.
3. Change ONE thing and run again. Green/red arrows show what got better or
   worse, and the "Score" column tells you the overall result across all metrics.
4. Type a note on each run so you remember what you changed.

Rule of thumb: look for a plateau, not a single peak - a group of similarly good
runs is more robust than one lucky outlier.


Good to know
------------
- No Python and no configuration needed. The backend runs on built-in Windows
  PowerShell and starts automatically via start-sq.bat.
- Your run history is stored here:
     ...\RunCompare\history\<StrategyName>.runs.txt
  Give different strategies different names so their histories don't mix.
- If you ever start StrategyQuant WITHOUT start-sq.bat, the plugin still works
  but won't remember history after you close SQ - so always launch via
  start-sq.bat.
- Moving to a new StrategyQuant version? Just copy your whole "user" folder over
  - it brings start-sq.bat, RunCompare, and your saved history in one go.


Need help? Reply to the email or message us - happy to help.
AlgoCloud Team
